home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / Config.h < prev    next >
C/C++ Source or Header  |  2002-01-14  |  8KB  |  318 lines
  1. //
  2. // (c) 1999 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // Config.h
  5. //
  6. // API for the package Config.
  7. //
  8. // Revision control information:
  9. //
  10. // $Header: /flux/packages/Config.h 9     12/04/01 14:52 Tim $
  11. //
  12.  
  13. #include "Flux.h"
  14.  
  15. #if (FLUX_COMPILE)
  16.  
  17. FLUX_DECLARE_EXTENSION(Config);
  18.  
  19. #ifdef FLUX_LIB
  20. #if _MSC_VER >= 1000
  21. #pragma comment( lib, "config" )
  22. #endif // _MSC_VER >= 1000
  23. #endif
  24.  
  25. #else
  26.  
  27. //
  28. // float GetFloat( string filename, string section, string key )
  29. //
  30. // Get the float value from the given INI file member.
  31. //
  32. prototype float Config.GetFloat( string filename, 
  33.                                  string section, 
  34.                                  string key );
  35.  
  36. //
  37. // float GetNumberedFloat( string filename, 
  38. //                           string section, 
  39. //                           string key,
  40. //                           int number ) 
  41. //
  42. // Get the float value from the given INI file member.
  43. //
  44. prototype float Config.GetNumberedFloat( string filename, 
  45.                                          string section, 
  46.                                          string key,
  47.                                          int number );
  48.  
  49. //
  50. // int GetInt( string filename, string section, string key )
  51. //
  52. // Get the int value from the given INI file member.
  53. //
  54. prototype int Config.GetInt( string filename, 
  55.                              string section, 
  56.                              string key );
  57.  
  58. //
  59. // int GetNumberedInt( string filename, 
  60. //                       string section, 
  61. //                       string key,
  62. //                       int number )
  63. //
  64. // Get the int value from the given INI file member.
  65. //
  66. prototype int Config.GetNumberedInt( string filename, 
  67.                                      string section, 
  68.                                      string key,
  69.                                      int number );
  70.  
  71. //
  72. // bool GetBool( string filename, string section, string key )
  73. //
  74. // Get the bool value from the given INI file member.
  75. //
  76. prototype int Config.GetBool( string filename, 
  77.                               string section, 
  78.                               string key );
  79.  
  80. //
  81. // int GetNumberedBool( string filename, 
  82. //                        string section, 
  83. //                        string key,
  84. //                        int number )
  85. //
  86. // Get the bool value from the given INI file member.
  87. //
  88. prototype int Config.GetNumberedBool( string filename, 
  89.                                       string section, 
  90.                                       string key,
  91.                                       int number );
  92.  
  93. //
  94. // string GetString( string filename, string section, string key )
  95. //
  96. // Get the string value from the given INI file member.
  97. //
  98. prototype string Config.GetString( string filename, 
  99.                                    string section, 
  100.                                    string key );
  101.  
  102. //
  103. // string GetNumberedString( string filename, 
  104. //                             string section, 
  105. //                             string key,
  106. //                             int number )
  107. //
  108. // Get the string value from the given INI file member.
  109. //
  110. prototype string Config.GetNumberedString( string filename, 
  111.                                            string section, 
  112.                                            string key,
  113.                                            int number );
  114.  
  115. //
  116. // float GetVectorX( string filename, string section, string key )
  117. //
  118. // Get the x component of a vector value from the given INI file member.
  119. //
  120. prototype float Config.GetVectorX( string filename, 
  121.                                    string section, 
  122.                                    string key );
  123.  
  124. //
  125. // float GetNumberedVectorX( string filename, 
  126. //                             string section, 
  127. //                             string key,
  128. //                             int number )
  129. //
  130. // Get the x component of a vector value from the given INI file member.
  131. //
  132. prototype float Config.GetNumberedVectorX( string filename, 
  133.                                            string section, 
  134.                                            string key,
  135.                                            int number );
  136.  
  137. //
  138. // float GetVectorY( string filename, string section, string key )
  139. //
  140. // Get the y component of a vector value from the given INI file member.
  141. //
  142. prototype float Config.GetVectorY( string filename, 
  143.                                    string section, 
  144.                                    string key );
  145.  
  146. //
  147. // float GetNumberedVectorY( string filename, 
  148. //                             string section, 
  149. //                             string key,
  150. //                             int number )
  151. //
  152. // Get the y component of a vector value from the given INI file member.
  153. //
  154. prototype float Config.GetNumberedVectorY( string filename, 
  155.                                            string section, 
  156.                                            string key,
  157.                                            int number );
  158.  
  159. //
  160. // float GetVectorZ( string filename, string section, string key )
  161. //
  162. // Get the z component of a vector value from the given INI file member.
  163. //
  164. prototype float Config.GetVectorZ( string filename, 
  165.                                    string section, 
  166.                                    string key );
  167.  
  168. //
  169. // float GetNumberedVectorZ( string filename, 
  170. //                             string section, 
  171. //                             string key,
  172. //                             int number )
  173. //
  174. // Get the z component of a vector value from the given INI file member.
  175. //
  176. prototype float Config.GetNumberedVectorZ( string filename, 
  177.                                            string section, 
  178.                                            string key,
  179.                                            int number );
  180.  
  181. //
  182. // void CreateFloat( string filename, string section, string key, float value )
  183. //
  184. // Create a new slot in the INI file and set the given value there. Fails if
  185. // there is already such a value.
  186. //
  187. prototype Config.CreateFloat( string filename, 
  188.                               string section, 
  189.                               string key, 
  190.                               float value );
  191.  
  192. //
  193. // void CreateInt( string filename, string section, string key, int value )
  194. //
  195. // Create a new slot in the INI file and set the given value there. Fails if
  196. // there is already such a value.
  197. //
  198. prototype Config.CreateInt( string filename, 
  199.                             string section, 
  200.                             string key, 
  201.                             int value );
  202.  
  203. //
  204. // void CreateBool( string filename, string section, string key, bool value )
  205. //
  206. // Create a new slot in the INI file and set the given value there. Fails if
  207. // there is already such a value.
  208. //
  209. prototype Config.CreateBool( string filename, 
  210.                              string section, 
  211.                              string key, 
  212.                              bool value );
  213.  
  214. //
  215. // void CreateString( string filename, string section, string key, string value )
  216. //
  217. // Create a new slot in the INI file and set the given value there. Fails if
  218. // there is already such a value.
  219. //
  220. prototype Config.CreateString( string filename, 
  221.                                string section, 
  222.                                string key, 
  223.                                string value );
  224.  
  225. //
  226. // void CreateVector( string filename, 
  227. //                      string section, 
  228. //                      string key, 
  229. //                      float x,
  230. //                      float y,
  231. //                    float z )
  232. //
  233. // Create a new slot in the INI file and set the given value there. Fails if
  234. // there is already such a value.
  235. //
  236. prototype Config.CreateVector( string filename, 
  237.                                string section, 
  238.                                string key, 
  239.                                string value );
  240.  
  241. //
  242. // SetFloat( string filename, string section, string key, float value )
  243. //
  244. // Set the given value to the given slot. Fails if the key does not exist 
  245. // in that section of the file.
  246. //
  247. prototype Config.SetFloat( string filename, 
  248.                            string section, 
  249.                            string key, 
  250.                            float value );
  251.  
  252. //
  253. // SetInt( string filename, string section, string key, int value )
  254. //
  255. // Set the given value to the given slot. Fails if the key does not exist 
  256. // in that section of the file.
  257. //
  258. prototype Config.SetInt( string filename, 
  259.                          string section, 
  260.                          string key, 
  261.                          int value );
  262.  
  263. //
  264. // SetBool( string filename, string section, string key, bool value )
  265. //
  266. // Set the given value to the given slot. Fails if the key does not exist 
  267. // in that section of the file.
  268. //
  269. prototype Config.SetBool( string filename, 
  270.                           string section, 
  271.                           string key, 
  272.                           bool value );
  273.  
  274. //
  275. // SetString( string filename, string section, string key, string value )
  276. //
  277. // Set the given value to the given slot. Fails if the key does not exist 
  278. // in that section of the file.
  279. //
  280. prototype Config.SetString( string filename, 
  281.                             string section, 
  282.                             string key, 
  283.                             string value );
  284.  
  285. //
  286. // SetVector( string filename, 
  287. //              string section, 
  288. //              string key, 
  289. //              float x,
  290. //              float y,
  291. //              float z )
  292. //
  293. // Set the given value to the given slot. Fails if the key does not exist 
  294. // in that section of the file.
  295. //
  296. prototype Config.SetVector( string filename, 
  297.                             string section, 
  298.                             string key, 
  299.                             float x,
  300.                             float y,
  301.                             float z );
  302.  
  303. //
  304. // bool Exists( string filename, string section, string key )
  305. //
  306. // Tests whether or not a given section and key exists in the given file.
  307. //
  308. prototype bool Config.Exists( string filename, string section, string key );
  309.  
  310. //
  311. // int CountNumber( string filename, string section, string key )
  312. //
  313. // How many entries are there for the given key?
  314. //
  315. prototype int Config.CountNumber( string filename, string section, string key );
  316.  
  317. #endif // FLUX_LIB
  318.